home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmMainWindow.z / XmMainWindow
Encoding:
Text File  |  2002-10-03  |  19.8 KB  |  265 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww - The MainWindow widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////MMMMaaaaiiiinnnnWWWW....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           MainWindow provides a standard layout for the primary window
  20.           of an application.  This layout includes a MenuBar, a
  21.           CommandWindow, a work region, a MessageWindow, and
  22.           ScrollBars.  Any or all of these areas are optional.  The
  23.           work region and ScrollBars in the MainWindow behave
  24.           identically to the work region and ScrollBars in the
  25.           ScrolledWindow widget.  The user can think of the MainWindow
  26.           as an extended ScrolledWindow with an optional MenuBar and
  27.           optional CommandWindow and MessageWindow.
  28.  
  29.           In a fully-loaded MainWindow, the MenuBar spans the top of
  30.           the window horizontally.  The CommandWindow spans the
  31.           MainWindow horizontally just below the MenuBar, and the work
  32.           region lies below the CommandWindow.  The MessageWindow is
  33.           is below the work region.  Any space remaining below the
  34.           MessageWindow is managed in a manner identical to
  35.           ScrolledWindow.  The behavior of ScrolledWindow can be
  36.           controlled by the ScrolledWindow resources.  To create a
  37.           MainWindow, first create the work region elements, a
  38.           MenuBar, a CommandWindow, a MessageWindow, a horizontal
  39.           ScrollBar, and a vertical ScrollBar widget, and then call
  40.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeettttAAAArrrreeeeaaaassss with those widget IDs.
  41.  
  42.           MainWindow can also create three Separator widgets that
  43.           provide a visual separation of MainWindow's four components.
  44.           The user can specify resources in a resource file for the
  45.           automatically created gadgets that contain the MainWindow
  46.           separators.  The name of the first separator gadget is
  47.           "Separator1"; the second is "Separator2"; and the third is
  48.           "Separator3".
  49.  
  50.         CCCCllllaaaasssssssseeeessss
  51.           MainWindow inherits behavior and resources from CCCCoooorrrreeee,
  52.           CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr, and SSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww
  53.           classes.
  54.  
  55.           The class pointer is xxxxmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  56.  
  57.           The class name is XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww.
  58.  
  59.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  60.  
  61.  
  62.  
  63.      PPPPaaaaggggeeee 1111                                          ((((pppprrrriiiinnnntttteeeedddd 4444////33330000////99998888))))
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           The following table defines a set of widget resources used
  75.           by the programmer to specify data.  The programmer can also
  76.           set the resource values for the inherited classes to set
  77.           attributes for this widget.  To reference a resource by name
  78.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  79.           prefix and use the remaining letters.  To specify one of the
  80.           defined values for a resource in a .Xdefaults file, remove
  81.           the XXXXmmmm prefix and use the remaining letters (in either
  82.           lowercase or uppercase, but include any underscores between
  83.           words).  The codes in the access column indicate if the
  84.           given resource can be set at creation time (C), set by using
  85.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  86.           not applicable (N/A).
  87.  
  88.                                          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  89.      NNNNaaaammmmeeee                        CCCCllllaaaassssssss                       TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt            AAAAcccccccceeeessssssss
  90.      _________________________________________________________________________________________________
  91.      XmNcommandWindow            XmCCommandWindow            Widget          NULL               CSG
  92.      XmNcommandWindowLocation    XmCCommandWindowLocation    unsigned char   ABOVE (SeeDesc.)   CG
  93.      XmNmainWindowMarginHeight   XmCMainWindowMarginHeight   Dimension       0                  CSG
  94.      XmNmainWindowMarginWidth    XmCMainWindowMarginWidth    Dimension       0                  CSG
  95.      XmNmenuBar                  XmCMenuBar                  Widget          NULL               CSG
  96.      XmNmessageWindow            XmCMessageWindow            Widget          NULL               CSG
  97.      XmNshowSeparator            XmCShowSeparator            Boolean         False              CSG
  98.  
  99.  
  100.           XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddWWWWiiiinnnnddddoooowwww
  101.                     Specifies the widget to be laid out as the
  102.                     CommandWindow.  This widget must have been
  103.                     previously created and managed as a child of
  104.                     MainWindow.
  105.  
  106.           XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddWWWWiiiinnnnddddoooowwwwLLLLooooccccaaaattttiiiioooonnnn
  107.                     Controls the position of the command window.
  108.                     XXXXmmmmCCCCOOOOMMMMMMMMAAAANNNNDDDD____AAAABBBBOOOOVVVVEEEE____WWWWOOOORRRRKKKKSSSSPPPPAAAACCCCEEEE locates the command
  109.                     window between the menu bar and the work window.
  110.                     XXXXmmmmCCCCOOOOMMMMMMMMAAAANNNNDDDD____BBBBEEEELLLLOOOOWWWW____WWWWOOOORRRRKKKKSSSSPPPPAAAACCCCEEEE locates the command
  111.                     window between the work window and the message
  112.                     window.
  113.  
  114.           XXXXmmmmNNNNmmmmaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt
  115.                     Specifies the margin height on the top and bottom
  116.                     of MainWindow.  This resource overrides any
  117.                     setting of the ScrolledWindow resource
  118.                     XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt.
  119.  
  120.           XXXXmmmmNNNNmmmmaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh
  121.                     Specifies the margin width on the right and left
  122.                     sides of MainWindow.  This resource overrides any
  123.                     setting of the ScrolledWindow resource
  124.                     XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           XXXXmmmmNNNNmmmmeeeennnnuuuuBBBBaaaarrrr
  141.                     Specifies the widget to be laid out as the
  142.                     MenuBar.  This widget must have been previously
  143.                     created and managed as a child of MainWindow.
  144.  
  145.           XXXXmmmmNNNNmmmmeeeessssssssaaaaggggeeeeWWWWiiiinnnnddddoooowwww
  146.                     Specifies the widget to be laid out as the
  147.                     MessageWindow.  This widget must have been
  148.                     previously created and managed as a child of
  149.                     MainWindow.  The MessageWindow is positioned at
  150.                     the bottom of the MainWindow.  If this value is
  151.                     NULL, no message window is included in the
  152.                     MainWindow.
  153.  
  154.           XXXXmmmmNNNNsssshhhhoooowwwwSSSSeeeeppppaaaarrrraaaattttoooorrrr
  155.                     Displays separators between the components of the
  156.                     MainWindow when set to True.  If set to False, no
  157.                     separators are displayed.
  158.  
  159.  
  160.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  161.           MainWindow inherits behavior and resources from the
  162.           following superclasses.  For a complete description of each
  163.           resource, refer to the man page for that superclass.
  164.  
  165.                                               XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  166.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                 AAAAcccccccceeeessssssss
  167.      _______________________________________________________________________________________________________________
  168.      XmNclipWindow                   XmCClipWindow                   Widget           dynamic                 G
  169.      XmNhorizontalScrollBar          XmCHorizontalScrollBar          Widget           dynamic                 CSG
  170.      XmNscrollBarDisplayPolicy       XmCScrollBarDisplayPolicy       unsigned char    dynamic                 CSG
  171.      XmNscrollBarPlacement           XmCScrollBarPlacement           unsigned char    XmBOTTOM_RIGHT          CSG
  172.      XmNscrolledWindowMarginHeight   XmCScrolledWindowMarginHeight   Dimension        0                       N/A
  173.      XmNscrolledWindowMarginWidth    XmCScrolledWindowMarginWidth    Dimension        0                       N/A
  174.      XmNscrollingPolicy              XmCScrollingPolicy              unsigned char    XmAPPLICATION_DEFINED   CG
  175.      XmNspacing                      XmCSpacing                      Dimension        4                       CSG
  176.      XmNtraverseObscuredCallback     XmCCallback                     XtCallbackList   NULL                    CSG
  177.      XmNverticalScrollBar            XmCVerticalScrollBar            Widget           dynamic                 CSG
  178.      XmNvisualPolicy                 XmCVisualPolicy                 unsigned char    dynamic                 G
  179.      XmNworkWindow                   XmCWorkWindow                   Widget           NULL                    CSG
  180.  
  181.                                           XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  182.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  183.      _________________________________________________________________________________________________
  184.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel               dynamic                CSG
  185.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  186.      XmNforeground           XmCForeground           Pixel               dynamic                CSG
  187.      XmNhelpCallback         XmCCallback             XtCallbackList      NULL                   C
  188.      XmNhighlightColor       XmCHighlightColor       Pixel               dynamic                CSG
  189.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap              dynamic                CSG
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  203.  
  204.  
  205.  
  206.      XmNinitialFocus         XmCInitialFocus         Widget              NULL                   CSG
  207.      XmNnavigationType       XmCNavigationType       XmNavigationType    XmTAB_GROUP            CSG
  208.      XmNshadowThickness      XmCShadowThickness      Dimension           0                      CSG
  209.      XmNstringDirection      XmCStringDirection      XmStringDirection   dynamic                CG
  210.      XmNtopShadowColor       XmCTopShadowColor       Pixel               dynamic                CSG
  211.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap              dynamic                CSG
  212.      XmNtraversalOn          XmCTraversalOn          Boolean             True                   CSG
  213.      XmNunitType             XmCUnitType             unsigned char       dynamic                CSG
  214.      XmNuserData             XmCUserData             XtPointer           NULL                   CSG
  215.  
  216.                              CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  217.      NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  218.      ______________________________________________________________________
  219.      XmNchildren         XmCReadOnly         WidgetList    NULL      G
  220.      XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  221.      XmNnumChildren      XmCReadOnly         Cardinal      0         G
  222.  
  223.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  224.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  225.      ______________________________________________________________________________________________________________
  226.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  227.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  228.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  229.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  230.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  231.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  232.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  233.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  234.      XmNdepth                        XmCDepth                        int              dynamic                CG
  235.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  236.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  237.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  238.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  239.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  240.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  241.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  242.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  243.      XmNx                            XmCPosition                     Position         0                      CSG
  244.      XmNy                            XmCPosition                     Position         0                      CSG
  245.  
  246.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  247.           MainWindow inherits translations from ScrolledWindow.
  248.  
  249.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  250.           CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX)))), CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt((((3333XXXX)))), CCCCoooorrrreeee((((3333XXXX)))),
  251.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX)))), XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeepppp1111((((3333XXXX)))),
  252.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeepppp2222((((3333XXXX)))), XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeepppp3333((((3333XXXX)))),
  253.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeettttAAAArrrreeeeaaaassss((((3333XXXX)))), XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr((((3333XXXX)))), and
  254.           XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.